docs: Move documentation to inline comments: regions

diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore
index ae9a98263493f707fb31b42fd3fd8b9a8c302c75..905a6f25fa6d1103d15b238b104aa9753ad1eaf9 100644 (file)
--- a/docs/reference/gdk/tmpl/.gitignore
+++ b/docs/reference/gdk/tmpl/.gitignore
@@ -1,3 +1,4 @@
 cairo_interaction.sgml
 dnd.sgml
+regions.sgml
 windows.sgml

diff --git a/docs/reference/gdk/tmpl/regions.sgml b/docs/reference/gdk/tmpl/regions.sgml
deleted file mode 100644 (file)
index 5236c54..0000000
--- a/docs/reference/gdk/tmpl/regions.sgml
+++ /dev/null
@@ -1,72 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-Points and Rectangles
-
-<!-- ##### SECTION Short_Description ##### -->
-Simple graphical data types
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-GDK provides the #GdkPoint and #GdkRectangle data types for representing pixels
-and sets of pixels on the screen. Together with Cairo's #cairo_region_t data
-type, they make up the central types for representing graphical data.
-</para>
-<para>
-#GdkPoint is a simple structure containing an x and y coordinate of a point.
-</para>
-<para>
-#GdkRectangle is a structure holding the position and size of a rectangle.
-The intersection of two rectangles can be computed with
-gdk_rectangle_intersect(). To find the union of two rectangles use
-gdk_rectangle_union().
-</para>
-<para>
-#cairo_region_t is usually used for managing clipping of graphical operations.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GdkPoint ##### -->
-<para>
-Defines the x and y coordinates of a point.
-</para>
-
-@x: the x coordinate of the point.
-@y: the y coordinate of the point.
-
-<!-- ##### TYPEDEF GdkRectangle ##### -->
-<para>
-Defines the position and size of a rectangle. It is identical to 
-#cairo_rectangle_int_t.
-</para>
-
-
-<!-- ##### FUNCTION gdk_rectangle_intersect ##### -->
-<para>
-
-</para>
-
-@src1: 
-@src2: 
-@dest: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_rectangle_union ##### -->
-<para>
-
-</para>
-
-@src1: 
-@src2: 
-@dest: 
-
-

diff --git a/gdk/gdkrectangle.c b/gdk/gdkrectangle.c
index 1b282476e5b49d7507bb163010ceb9238770a5a3..03ce78c743e384bfc692bf2973ee32bd091e9d25 100644 (file)
--- a/gdk/gdkrectangle.c
+++ b/gdk/gdkrectangle.c
@@ -28,6 +28,26 @@
 #include <gdk/gdk.h>
 
 
+/**
+ * SECTION:regions
+ * @Short_description: Simple graphical data types
+ * @Title: Points and Rectangles
+ *
+ * GDK provides the #GdkPoint and #GdkRectangle data types for representing pixels
+ * and sets of pixels on the screen. Together with Cairo's #cairo_region_t data
+ * type, they make up the central types for representing graphical data.
+ *
+ * #GdkPoint is a simple structure containing an x and y coordinate of a point.
+ *
+ * #GdkRectangle is a structure holding the position and size of a rectangle.
+ * The intersection of two rectangles can be computed with
+ * gdk_rectangle_intersect(). To find the union of two rectangles use
+ * gdk_rectangle_union().
+ *
+ * #cairo_region_t is usually used for managing clipping of graphical operations.
+ */
+
+
 /**
  * gdk_rectangle_union:
  * @src1: a #GdkRectangle

diff --git a/gdk/gdktypes.h b/gdk/gdktypes.h
index a5543d93386b12268b857804211ca885087f5105..aaa17b59e1e237c80da02fdb264905160f39a576 100644 (file)
--- a/gdk/gdktypes.h
+++ b/gdk/gdktypes.h
@@ -64,6 +64,13 @@ G_BEGIN_DECLS
 /* Type definitions for the basic structures.
  */
 typedef struct _GdkPoint             GdkPoint;
+
+/**
+ * GdkRectangle:
+ *
+ * Defines the position and size of a rectangle. It is identical to
+ * #cairo_rectangle_int_t.
+ */
 typedef cairo_rectangle_int_t        GdkRectangle;
 
 typedef struct _GdkAtom            *GdkAtom;
@@ -245,6 +252,13 @@ typedef enum
   GDK_ALL_EVENTS_MASK           = 0x3FFFFE
 } GdkEventMask;
 
+/**
+ * GdkPoint:
+ * @x: the x coordinate of the point.
+ * @y: the y coordinate of the point.
+ *
+ * Defines the x and y coordinates of a point.
+ */
 struct _GdkPoint
 {
   gint x;